Docs: own and sync ClickHouse documentation#2945
Conversation
Blargian
changed the title
|
@chernser assuming the two failing checks here are unrelated to this change? |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 3 potential issues.
Reviewed by Cursor Bugbot for commit 592e8d1. Configure here.
| release) | ||
| if [[ "$RELEASE_PRERELEASE" == "true" ]]; then | ||
| echo "Release ${RELEASE_TAG} is a prerelease; skipping." | ||
| elif [[ "${RELEASE_TAG#v}" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then |
There was a problem hiding this comment.
Release sync skips prereleases
Medium Severity
The new sync workflow skips published releases when github.event.release.prerelease is true, but the repository’s existing Release workflow always creates GitHub releases with --prerelease. The release trigger path therefore never runs after a normal release; docs only sync via sync-docs merges or manual dispatch unless someone later clears the prerelease flag by hand.
Reviewed by Cursor Bugbot for commit 592e8d1. Configure here.
| with: | ||
| # On a release, take the docs as of the released tag; otherwise take | ||
| # the default checkout (post-merge default branch / dispatched ref). | ||
| ref: ${{ github.event_name == 'release' && github.event.release.tag_name || '' }} |
There was a problem hiding this comment.
Fork merge checkout fails
High Severity
The sync job leaves actions/checkout@v5 on its default ref for merged pull_request_target runs. Since the July 2026 checkout backport, that default often resolves to the fork merge commit and the step refuses to check out, so the expedited sync-docs path can fail after external PRs merge even though the gate passed.
Reviewed by Cursor Bugbot for commit 592e8d1. Configure here.
| ### Changelog entry (a [user-readable short description](https://github.com/ClickHouse/ClickHouse/blob/master/docs/changelog_entry_guidelines.md) of the changes that goes into CHANGELOG.md): | ||
| Sync language client documentation from \`${SOURCE_REPO}\`. | ||
| EOF | ||
| ) |
There was a problem hiding this comment.
Indented heredoc breaks body
Medium Severity
The aggregator PR body is built with a plain heredoc whose lines are indented to match the YAML block. Bash keeps those leading spaces, so changelog headings and bullets are not at column zero and downstream ClickHouse/ClickHouse PR checks may not recognize the required template.
Reviewed by Cursor Bugbot for commit 592e8d1. Configure here.
2 participants
Summary
Make
ClickHouse/clickhouse-javathe source of truth for its public ClickHouse documentation.ClickHouse/ClickHouse@21ed77718a5f454680497924d68e9f60a41e026cintodocs/clickhouse-docs/, with trailing whitespace normalized. The dedicated subdirectory keeps repository-only engineering docs out of the published slice.ClickHouse/ClickHousedocs PR after a release, manual dispatch, or merge carrying thesync-docslabel.The published URLs and aggregator path remain unchanged. This does not change the Java API or runtime behavior.
After merge, maintainers should confirm the
sync-docslabel exists and the Workflow Auth GitHub App credentials are available to this repository.Validation
actionlintv1.7.7 and YAML parsing.git diff --checkpasses.